<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>重命名一个文件或目录</title>
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-base.css" />
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-medium.css" />

 </head>
 <body class="docs"><div class="navbar navbar-fixed-top">
  <div class="navbar-inner clearfix">
    <ul class="nav" style="width: 100%">
      <li style="float: left;"><a href="function.realpath.html">« realpath</a></li>
      <li style="float: right;"><a href="function.rewind.html">rewind »</a></li>
    </ul>
  </div>
</div>
<div id="breadcrumbs" class="clearfix">
  <ul class="breadcrumbs-container">
    <li><a href="index.html">PHP Manual</a></li>
    <li><a href="ref.filesystem.html">文件系统函数</a></li>
    <li>重命名一个文件或目录</li>
  </ul>
</div>
<div id="layout">
  <div id="layout-content"><div id="function.rename" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">rename</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">rename</span> &mdash; <span class="dc-title">重命名一个文件或目录</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.rename-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>rename</strong></span>(<span class="methodparam"><span class="type">string</span> <code class="parameter">$from</code></span>, <span class="methodparam"><span class="type">string</span> <code class="parameter">$to</code></span>, <span class="methodparam"><span class="type">?</span><span class="type"><span class="type">resource</span><span class="type"></span></span> <code class="parameter">$context</code><span class="initializer"> = <strong><code>null</code></strong></span></span>): <span class="type">bool</span></div>

  <p class="para rdfs-comment">
   尝试把 <code class="parameter">from</code> 重命名为
   <code class="parameter">to</code>，必要时会在不同目录间移动。
   如果重命名文件时 <code class="parameter">to</code> 已经存在，将会覆盖掉它。
   如果重命名文件夹时
   <code class="parameter">to</code> 已经存在，本函数将导致一个警告。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.rename-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt>
<code class="parameter">from</code></dt>

     <dd>

      <p class="para">
       原名
      </p>
      <blockquote class="note"><p><strong class="note">注意</strong>: 
       <p class="para">
        用于 <code class="parameter">from</code> 中的封装协议<em class="emphasis">必须</em>和用于
        <code class="parameter">to</code> 中的相匹配。
       </p>
      </p></blockquote>
     </dd>

    
    
     <dt>
<code class="parameter">to</code></dt>

     <dd>

      <p class="para">
       新的名字。
       <blockquote class="note"><p><strong class="note">注意</strong>: 
        <span class="simpara">
         在 Windows 上，如果 <code class="parameter">to</code> 已经存在，它必须是可写的。
         否则 <span class="function"><strong>rename()</strong></span> 将失败，并导致 <strong><code>E_WARNING</code></strong>。
        </span>
       </p></blockquote>
      </p>
     </dd>

    
    
     <dt>
<code class="parameter">context</code></dt>

     <dd>

      <p class="para"><a href="stream.contexts.html" class="link">上下文流（context stream）</a>
<span class="type">resource</span>。</p>
     </dd>

    
   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.rename-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   成功时返回 <strong><code>true</code></strong>， 或者在失败时返回 <strong><code>false</code></strong>。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.rename-examples">
  <h3 class="title">范例</h3>
  <p class="para">
   <div class="example" id="example-2223">
    <p><strong>示例 #1  <span class="function"><strong>rename()</strong></span> 例子</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />rename</span><span style="color: #007700">(</span><span style="color: #DD0000">"/tmp/tmp_file.txt"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"/home/user/login/docs/my_file.txt"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.rename-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"><span class="function"><a href="function.copy.html" class="function" rel="rdfs-seeAlso">copy()</a> - 拷贝文件</span></li>
    <li class="member"><span class="function"><a href="function.unlink.html" class="function" rel="rdfs-seeAlso">unlink()</a> - 删除文件</span></li>
    <li class="member"><span class="function"><a href="function.move-uploaded-file.html" class="function" rel="rdfs-seeAlso">move_uploaded_file()</a> - 将上传的文件移动到新位置</span></li>
   </ul>
  </p>
 </div>


</div></div></div></body></html>